<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>vprocss: xvprocss_log.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">vprocss
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xvprocss__log_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xvprocss_log.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>Contains Event Logging routines for xvprocss. </p>
<dl class="section note"><dt>Note</dt><dd>None.</dd></dl>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date     Changes
<hr/>

2.00  dmc  01/11/16 Initial release.
      dmc  03/03/16 Add events for VDMA configuration and operational errors
2.20  rco  11/01/16 Change setup ignore messages (for csc, hscaler, vscaler
                    etc.) severity from Info to Error
2.30  rco  11/15/16 Make debug log optional (can be disabled via makefile)*
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a7bde6b4ee20f3546da3db9c8b3295d59"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss__log_8c.html#a7bde6b4ee20f3546da3db9c8b3295d59">XVprocSs_LogReset</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:a7bde6b4ee20f3546da3db9c8b3295d59"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will reset the driver's logging mechanism.  <a href="#a7bde6b4ee20f3546da3db9c8b3295d59">More...</a><br /></td></tr>
<tr class="separator:a7bde6b4ee20f3546da3db9c8b3295d59"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a477ddfa18fa5fda8658ec72fb29a2d25"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss__log_8c.html#a477ddfa18fa5fda8658ec72fb29a2d25">XVprocSs_LogWrite</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, <a class="el" href="group__vprocss.html#gadda80cee8527fb0dac1e98e657f12cd9">XVprocSs_LogEvent</a> Evt, u8 Data)</td></tr>
<tr class="memdesc:a477ddfa18fa5fda8658ec72fb29a2d25"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will insert an event in the driver's logging mechanism.  <a href="#a477ddfa18fa5fda8658ec72fb29a2d25">More...</a><br /></td></tr>
<tr class="separator:a477ddfa18fa5fda8658ec72fb29a2d25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf3fd2ffbed19ddf48ee19ef9368e5ac"><td class="memItemLeft" align="right" valign="top">u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss__log_8c.html#adf3fd2ffbed19ddf48ee19ef9368e5ac">XVprocSs_LogRead</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:adf3fd2ffbed19ddf48ee19ef9368e5ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will read the last event from the log.  <a href="#adf3fd2ffbed19ddf48ee19ef9368e5ac">More...</a><br /></td></tr>
<tr class="separator:adf3fd2ffbed19ddf48ee19ef9368e5ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b5f492aa1f70696ace6462ac901c137"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss__log_8c.html#a7b5f492aa1f70696ace6462ac901c137">XVprocSs_LogDisplay</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:a7b5f492aa1f70696ace6462ac901c137"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will read and print the entire event log.  <a href="#a7b5f492aa1f70696ace6462ac901c137">More...</a><br /></td></tr>
<tr class="separator:a7b5f492aa1f70696ace6462ac901c137"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a7b5f492aa1f70696ace6462ac901c137"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b5f492aa1f70696ace6462ac901c137">&#9670;&nbsp;</a></span>XVprocSs_LogDisplay()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVprocSs_LogDisplay </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function will read and print the entire event log. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_vproc_ss.html" title="The XVprocSs driver instance data. ">XVprocSs</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>After reading out all events, the log will be empty. </dd></dl>

</div>
</div>
<a id="adf3fd2ffbed19ddf48ee19ef9368e5ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf3fd2ffbed19ddf48ee19ef9368e5ac">&#9670;&nbsp;</a></span>XVprocSs_LogRead()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u16 XVprocSs_LogRead </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function will read the last event from the log. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_vproc_ss.html" title="The XVprocSs driver instance data. ">XVprocSs</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The log data.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>The read is "destructive" in the sense an event may only be read once, the read pointer then advancing to the next entry. After reading all the events (see routine XVprocSs_LogDisplay), the log will be empty. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_vproc_ss.html#a28ee766c6efe0487a38b1e643bf2cbc0">XVprocSs::Log</a>, <a class="el" href="group__vprocss.html#ga463361d1b27cc99ddbad5d50e1385afa">XVPROCSS_EVT_BUFFSIZE</a>, and <a class="el" href="group__vprocss.html#ggadda80cee8527fb0dac1e98e657f12cd9a3ba0825358703c04ed25a3745c47a192">XVPROCSS_EVT_NONE</a>.</p>

</div>
</div>
<a id="a7bde6b4ee20f3546da3db9c8b3295d59"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7bde6b4ee20f3546da3db9c8b3295d59">&#9670;&nbsp;</a></span>XVprocSs_LogReset()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVprocSs_LogReset </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function will reset the driver's logging mechanism. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_vproc_ss.html" title="The XVprocSs driver instance data. ">XVprocSs</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>HeadIndex == TailIndex means that the log is empty. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_vproc_ss.html#a28ee766c6efe0487a38b1e643bf2cbc0">XVprocSs::Log</a>.</p>

</div>
</div>
<a id="a477ddfa18fa5fda8658ec72fb29a2d25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a477ddfa18fa5fda8658ec72fb29a2d25">&#9670;&nbsp;</a></span>XVprocSs_LogWrite()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVprocSs_LogWrite </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__vprocss.html#gadda80cee8527fb0dac1e98e657f12cd9">XVprocSs_LogEvent</a>&#160;</td>
          <td class="paramname"><em>Evt</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>Data</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function will insert an event in the driver's logging mechanism. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_vproc_ss.html" title="The XVprocSs driver instance data. ">XVprocSs</a> core instance. </td></tr>
    <tr><td class="paramname">Evt</td><td>is the event type to log. </td></tr>
    <tr><td class="paramname">Data</td><td>is the associated data for the event.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>The DataBuffer is circular. If full, new events will overwrite oldest events. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_vproc_ss.html#a28ee766c6efe0487a38b1e643bf2cbc0">XVprocSs::Log</a>, <a class="el" href="group__vprocss.html#ga463361d1b27cc99ddbad5d50e1385afa">XVPROCSS_EVT_BUFFSIZE</a>, and <a class="el" href="group__vprocss.html#ggadda80cee8527fb0dac1e98e657f12cd9ad0f8885a219b90be8a513ad6665c130d">XVPROCSS_EVT_LAST_ENUM</a>.</p>

<p class="reference">Referenced by <a class="el" href="xvprocss_8h.html#aac138624e6b5449040be8bd02710a512">XVprocSs_CfgInitialize()</a>, <a class="el" href="xvprocss_8h.html#ab56e5e6f01e06d85a9f1e50ea1123413">XVprocSs_SetPictureDemoWindow()</a>, <a class="el" href="xvprocss_8h.html#a34d1e25e364c4699c60ee30839f141f7">XVprocSs_SetPIPBackgroundColor()</a>, <a class="el" href="xvprocss_8h.html#a84b1254cbeac02b7f81b1b90c721e84d">XVprocSs_SetPipMode()</a>, <a class="el" href="xvprocss_8h.html#a799db27e282d2762ee5cf4be40e70712">XVprocSs_SetZoomMode()</a>, <a class="el" href="xvprocss_8h.html#a1f28821282af5defa07408d1c00c2bfe">XVprocSs_Stop()</a>, <a class="el" href="group__vprocss.html#gac64c8e364daf39e7651eed206c2d0850">XVprocSs_SubcoreInitCsc()</a>, <a class="el" href="group__vprocss.html#ga9daad66c25baa7c1bae1d20cc98f6de6">XVprocSs_SubcoreInitDeinterlacer()</a>, <a class="el" href="group__vprocss.html#gadcf7e51fe6694861af6f60966486e377">XVprocSs_SubcoreInitHCrsmplr()</a>, <a class="el" href="group__vprocss.html#ga37a3b40bf8023df481f8a754dd66c265">XVprocSs_SubcoreInitHScaler()</a>, <a class="el" href="group__vprocss.html#ga189ca6f1b0d8bbc9d8a0bdbf3305ca9e">XVprocSs_SubcoreInitLetterbox()</a>, <a class="el" href="group__vprocss.html#ga02845975c50815d61ada800f45c5b2f2">XVprocSs_SubcoreInitResetAximm()</a>, <a class="el" href="group__vprocss.html#gad19dfad7c200c92b4f3aa56427cd3a5c">XVprocSs_SubcoreInitResetAxis()</a>, <a class="el" href="group__vprocss.html#ga6052a82202855525ff99f7ee1539d9ac">XVprocSs_SubcoreInitRouter()</a>, <a class="el" href="group__vprocss.html#ga0cdee507022445a5080d2895ad38eedc">XVprocSs_SubcoreInitVCrsmpleIn()</a>, <a class="el" href="group__vprocss.html#gaf80bf035984ff1d10c5205840c94673f">XVprocSs_SubcoreInitVCrsmpleOut()</a>, <a class="el" href="group__vprocss.html#gabc2baba55536b58504a6a19d9835b780">XVprocSs_SubcoreInitVdma()</a>, <a class="el" href="group__vprocss.html#ga11671a79af5d522b00908b9f7df259ca">XVprocSs_SubcoreInitVScaler()</a>, and <a class="el" href="xvprocss_8h.html#a4bdc6a00278cb1c847429d7498f8505e">XVprocSs_UpdateZoomPipWindow()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
